Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 6, 2026

Description

This PR updates the README.md documentation to improve the Quick Start guide by making the LoongCollector/Jaeger setup optional, adding comprehensive AgentScope Studio integration with trace data export configuration, updating AgentScope repository links, and reorganizing the list of supported AI frameworks to clearly distinguish between LoongSuite enhanced instrumentations and upstream OpenTelemetry instrumentations.

Changes Made

  • Made Jaeger section optional: Updated the "Forwarding OTLP Data to Jaeger via LoongCollector" section heading to "(Optional) Forwarding OTLP Data to Jaeger via LoongCollector" to clarify that this configuration is not required for basic usage.

  • Added AgentScope Studio section: Created a new section "Using AgentScope Studio to View Tracing Data" that includes:

  • Added trace data export configuration: Created a subsection "Export AgentScope Data to AgentScope Studio" with:

    • Two configuration approaches: command-line flags and environment variables
    • Command-line example using --traces_exporter, --exporter_otlp_protocol, and --exporter_otlp_endpoint flags
    • Environment variable example using OTEL_SERVICE_NAME, OTEL_EXPORTER_OTLP_PROTOCOL, and OTEL_EXPORTER_OTLP_TRACES_ENDPOINT variables
    • Complete examples showing how to export trace data to AgentScope Studio using loongsuite-instrument (metrics collection is not currently supported)
  • Updated AgentScope repository links: Changed all AgentScope links from https://github.com/modelscope/agentscope to the new repository URL https://github.com/agentscope-ai/agentscope in three locations:

    • Supported AI Frameworks and components section
    • Quick start section
    • Resources section
  • Reorganized AI frameworks section: Restructured the "Supported AI Frameworks and components" section into two distinct categories with explanatory text:

    • LoongSuite enhanced instrumentations (loongsuite-instrumentation-* prefix): AgentScope, Dify, LangChain, MCP Client, Agno, DashScope, Mem0
    • Upstream synchronized instrumentations (opentelemetry-instrumentation-* prefix): OpenAI, OpenAI Agents, Google GenAI, Vertex AI, Weaviate
    • Added clarifying text to explain that upstream OpenTelemetry plugins are synchronized from the upstream project, while loongsuite plugins are new additions developed by the LoongSuite team
  • Fixed guide paths: Updated guide paths to correctly point to instrumentation-loongsuite directory for frameworks maintained there, and added missing guide link for MCP Client.

  • Fixed typo: Corrected spelling error in LoongCollector description (prodivdes → provides)

These changes provide users with clear, well-organized documentation that distinguishes between LoongSuite's enhanced instrumentations and synchronized upstream OpenTelemetry plugins, with flexible instructions for visualizing trace data using AgentScope Studio as an alternative to the Jaeger setup.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Verified README.md renders correctly with the updated headings and new sections
  • Confirmed all links are valid and point to correct resources
  • Validated configuration examples follow OpenTelemetry standards for trace export
  • Verified all framework guide paths exist in the repository
  • Confirmed proper categorization of loongsuite vs upstream instrumentations
  • Code review completed with no issues

Does This PR Require a Core Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated
Original prompt

帮我优化 readme 文档:

  1. 将里面的 AgentScope 的链接换成最新的:https://github.com/agentscope-ai/agentscope
  2. Supported AI Frameworks and components 这一部分你看看有没有遗漏的框架不在这里的需要补充一下.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@CLAassistant
Copy link

CLAassistant commented Jan 6, 2026

CLA assistant check
All committers have signed the CLA.

Copilot AI requested a review from ralf0131 January 6, 2026 00:58
Copilot stopped work on behalf of ralf0131 due to an error January 6, 2026 00:58
@ralf0131
Copy link
Collaborator

ralf0131 commented Jan 6, 2026

@copilot 刚才还没说完:
3. Forwarding OTLP Data to Jaeger via LoongCollector 这一部分改为可选项
4. 最后增加一节,使用 AgentScope Studio 来查看 tracing 数据,该项目可以在这里看到https://github.com/agentscope-ai/agentscope-studio

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot 刚才还没说完:
3. Forwarding OTLP Data to Jaeger via LoongCollector 这一部分改为可选项
4. 最后增加一节,使用 AgentScope Studio 来查看 tracing 数据,该项目可...

I've completed both changes:

  1. Made "Forwarding OTLP Data to Jaeger via LoongCollector" section optional by adding "(Optional)" to the heading
  2. Added a new section "Using AgentScope Studio to View Tracing Data" that references https://github.com/agentscope-ai/agentscope-studio

Changes committed in 87bedf0.

Copilot AI changed the title [WIP] Update README documentation with new AgentScope link Update README documentation with AgentScope Studio section Jan 6, 2026
@ralf0131
Copy link
Collaborator

ralf0131 commented Jan 6, 2026

@copilot 还需要吧 AgentScope 框架的数据上报到 AgentScope Studio,你具体可以参考 https://github.com/alibaba/loongsuite-python-agent/tree/main/instrumentation-loongsuite/loongsuite-instrumentation-agentscope 这个文档

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot 还需要吧 AgentScope 框架的数据上报到 AgentScope Studio,你具体可以参考 https://github.com/alibaba/loongsuite-python-agent/tree/main/instrumentation-loongsuite/loongsuite-i...

I've added a new subsection "Export AgentScope Data to AgentScope Studio" with configuration details showing how to export telemetry data using OTLP. The section includes:

  • OTLP endpoint configuration (http://127.0.0.1:31415)
  • Environment variables setup (OTEL_SERVICE_NAME, OTEL_EXPORTER_OTLP_PROTOCOL, endpoints)
  • Example command using loongsuite-instrument with traces and metrics exporters

Changes committed in de72ccf.

Copilot AI changed the title Update README documentation with AgentScope Studio section Update README documentation with AgentScope Studio integration Jan 6, 2026
@ralf0131
Copy link
Collaborator

ralf0131 commented Jan 6, 2026

@copilot 当前还不支持 metrics 的收集,先把 metrics 的端点给去掉

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot 当前还不支持 metrics 的收集,先把 metrics 的端点给去掉

Removed all metrics-related configuration from the AgentScope Studio section:

  • Removed --metrics_exporter otlp from command-line example
  • Removed OTEL_EXPORTER_OTLP_METRICS_ENDPOINT from environment variable example
  • Updated description to only mention traces

Changes committed in af9af05.

@ralf0131
Copy link
Collaborator

ralf0131 commented Jan 6, 2026

@copilot 还有两个关于 readme 文档的需求

  1. 将里面的 AgentScope 的链接换成最新的:https://github.com/agentscope-ai/agentscope
  2. Supported AI Frameworks and components 这一部分你看看有没有遗漏的框架不在这里的需要补充一下.

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot 还有两个关于 readme 文档的需求

  1. 将里面的 AgentScope 的链接换成最新的:https://github.com/agentscope-ai/agentscope
  2. Supported AI Frameworks and components 这一部...

Completed both updates:

  1. Updated all AgentScope links to the new URL: https://github.com/agentscope-ai/agentscope (3 occurrences updated)

  2. Added 6 missing AI frameworks to the "Supported AI Frameworks and components" section:

    • OpenAI Agents
    • Google GenAI
    • Vertex AI
    • DashScope
    • Mem0
    • Weaviate

Also fixed guide paths to point to instrumentation-loongsuite for frameworks that were moved there.

Changes committed in 2e5a095.

Copilot AI changed the title Update README documentation with AgentScope Studio integration Update README documentation with AgentScope Studio integration and framework list Jan 6, 2026
@ralf0131
Copy link
Collaborator

ralf0131 commented Jan 6, 2026

@copilot 不太对,你需要把 opentelemetry-instrumentation-开头的插件和 loongsuite-instrumentation-开头的插件分开,在 README 中只体现 loongsuite-instrumentation-开头的插件,可以说明一下 opentelemetry 插件是上游的,我们只是做了同步。loongsuite 开头的才是新增的

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot 不太对,你需要把 opentelemetry-instrumentation-开头的插件和 loongsuite-instrumentation-开头的插件分开,在 README 中只体现 loongsuite-instrumentation-开头的插��...

Reorganized the "Supported AI Frameworks and components" section with two distinct groups:

LoongSuite enhanced instrumentations (loongsuite-instrumentation-*):

  • AgentScope, Dify, LangChain, MCP Client, Agno, DashScope, Mem0

Upstream OpenTelemetry instrumentations (opentelemetry-instrumentation-*):

  • OpenAI, OpenAI Agents, Google GenAI, Vertex AI, Weaviate

Added explanatory text to clarify that upstream plugins are synchronized from OpenTelemetry, while loongsuite plugins are new additions.

Changes committed in 4d92ca7.

Copilot AI changed the title Update README documentation with AgentScope Studio integration and framework list Update README documentation with AgentScope Studio integration and reorganized framework list Jan 6, 2026
… section

Change-Id: Ia89adef07971514e8667a6101c1b60dc4ca88895
Co-developed-by: Cursor <[email protected]>
Co-authored-by: ralf0131 <[email protected]>
ralf0131 and others added 4 commits January 6, 2026 17:49
Change-Id: I038ee5920f8d33892d1b9163b6877a235803b711
Co-developed-by: Cursor <[email protected]>
Co-authored-by: ralf0131 <[email protected]>
Change-Id: I36497b1c2c17a74b0702dc418e4f3c02dd460242
Co-developed-by: Cursor <[email protected]>
Co-authored-by: ralf0131 <[email protected]>
Change-Id: I1e715fa5ee15533a87ca8b858734e23aefd6ddc2
Co-developed-by: Cursor <[email protected]>
Co-authored-by: ralf0131 <[email protected]>
…e Studio

Change-Id: I2d54f077a3fdeafcf0c4e6d82fb3ebdb9f95a39b
Co-developed-by: Cursor <[email protected]>
Co-authored-by: ralf0131 <[email protected]>
@ralf0131 ralf0131 force-pushed the copilot/update-readme-document branch from 223dd71 to b489fa8 Compare January 6, 2026 09:52
@ralf0131 ralf0131 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 6, 2026
@ralf0131 ralf0131 marked this pull request as ready for review January 7, 2026 02:16
@ralf0131 ralf0131 merged commit ba777b5 into main Jan 7, 2026
1347 of 1353 checks passed
@ralf0131 ralf0131 deleted the copilot/update-readme-document branch January 7, 2026 02:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants